/*-
 * Copyright (c) 2012 CTPP Team
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the CTPP Team nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      CharTables.hpp
 *
 * $CTPP$
 */
#ifndef _CHAR_TABLES_HPP__
#define _CHAR_TABLES_HPP__ 1

/*
  @file CharTables.hpp
  @brief Character translation tables & accessors

  Unicode uppercase to lowercase conversion mapping table
  http://publib.boulder.ibm.com/infocenter/systems/index.jsp?topic=/nls/rbagslowtoupmaptable.htm&tocNode=int_39939

  Unicode lowercase to uppercase conversion mapping table
  http://publib.boulder.ibm.com/infocenter/systems/index.jsp?topic=/nls/rbagslowtoupmaptable.htm&tocNode=int_39940
*/

// Local includes
#include "Types.h"

namespace FTSS
{

/**
  @class CharTable CharTables.hpp <CharTables.hpp>
  @brief Unicode characters tables & utilities
*/
class CharTable
{
public:

	/**
	  @brief Convert an upper-case letter to the corresponding lower-case letter.
	*/
	static UINT_32 Lowercase(const UINT_32 iChar);

	/**
	  @brief Convert an lower-case letter to the corresponding upper-case letter.
	*/
	static UINT_32 Uppercase(const UINT_32 iChar);

	/**
	  @brief Get sorting order for specified char.
	*/
	static UINT_32 LowercaseSortOrder(UINT_32 iChar);

	/**
	  @brief Get sorting order for specified char.
	*/
	static UINT_32 UppercaseSortOrder(UINT_32 iChar);

private:
	struct UCSTransMap
	{
		/** Source character                  */
		UINT_32    sc;
		/** Destination character             */
		UINT_32    dc;
		/** Sorting order                     */
		UINT_32    sortorder;
		/** Source character description      */
		CCHAR_P    desc_sc;
		/** Destination character description */
		CCHAR_P    desc_dc;
	};

	/** Upper-to-lower case translation map */
	static UCSTransMap mUCSU2L[];
	/** Lower-to-upper case translation map */
	static UCSTransMap mUCSL2U[];
};

} // namespace MAIL
#endif // _CHAR_TABLES_HPP__
// End.
